dev-ai #264

Bistard · 2025-02-01T18:54:15Z

Summary by Sourcery

New Features:

new service: IAITextService: Integrate OpenAI and DeepSeek AI text models for text generation.
new service: IEncryptionService: support encryption/decryption functionality
new registrant: AIModelRegistrant
- new base class: LLMModel
- new base class: TextSharedOpenAIModel
- new model: TextGPTModel
- new model: TextDeepSeekModel
new error: AIError for standardized error handling relates to LLM

… `TextDeepSeekModel`

sourcery-ai · 2025-02-01T18:54:20Z

Reviewer's Guide by Sourcery

This pull request introduces AI text generation capabilities using OpenAI and DeepSeek models. It includes new services for AI text generation and encryption, along with corresponding models and error handling. The changes also involve integrating these services into the application, allowing users to leverage AI for text-related tasks.

Sequence diagram for AI text request flow

sequenceDiagram
    participant Browser
    participant BrowserChannel as BrowserAITextChannel
    participant MainService as MainAITextService
    participant Model as AI Model
    participant API as AI Provider API

    Browser->>BrowserChannel: sendRequest(options)
    BrowserChannel->>MainService: IPC call: sendRequest
    MainService->>Model: sendRequest(options)
    Model->>API: API request
    API-->>Model: Response
    Model-->>MainService: Formatted response
    MainService-->>BrowserChannel: IPC response
    BrowserChannel-->>Browser: AI.Text.Response

Class diagram for AI text service and models

classDiagram
    class IAITextService {
        <<interface>>
        +init()
        +switchModel(options)
        +updateAPIKey(newKey, modelType, persisted)
        +sendRequest(options)
        +sendRequestStream(options, onChunkReceived)
    }

    class LLMModel {
        <<abstract>>
        +modality: AI.Modality
        +name: AI.ModelName
        +apiKey: string
        +setAPIKey(newKey)
    }

    class TextSharedOpenAIModel {
        <<abstract>>
        +modality: AI.Modality.Text
        +name: AI.ModelName
        +apiKey: string
        +setAPIKey(newKey)
        +sendRequest(options)
        +sendRequestStream(options, onChunkReceived)
    }

    class TextGPTModel {
        +name: AI.ModelName.ChatGPT
    }

    class TextDeepSeekModel {
        +name: AI.ModelName.DeepSeek
    }

    LLMModel <|-- TextSharedOpenAIModel
    TextSharedOpenAIModel <|-- TextGPTModel
    TextSharedOpenAIModel <|-- TextDeepSeekModel

    note for TextSharedOpenAIModel "Base class for OpenAI-compatible models"
    note for LLMModel "Base class for all LLM models"

File-Level Changes

Change	Details	Files
Introduces a new service for AI text generation, integrating OpenAI and DeepSeek models.	Defines the `IAITextService` interface and its implementation `MainAITextService`. Adds methods for initializing, switching, and sending requests to AI models. Integrates with `IConfigurationService` and `IMainStatusService` for API key management. Introduces `AIError` for standardized error handling. Adds `TextGPTModel` and `TextDeepSeekModel` for handling OpenAI and DeepSeek models respectively. Introduces `LLMModel` as a base class for all LLM-related models. Adds `AIModelRegistrant` to register different AI models. Adds `BrowserAITextChannel` and `MainAITextChannel` for IPC communication.	`src/platform/ai/electron/mainAITextService.ts` `src/platform/ai/common/aiText.ts` `src/platform/ai/electron/openAIModel.ts` `src/platform/ai/electron/GPTModel.ts` `src/platform/ai/electron/deepSeekModel.ts` `src/platform/ai/common/ai.ts` `src/platform/ai/electron/llmModel.ts` `src/platform/ai/common/aiModel.register.ts` `src/platform/ai/common/aiTextChannel.ts`
Implements encryption/decryption functionality for sensitive data like API keys.	Defines the `IEncryptionService` interface and its implementation `MainEncryptionService`. Uses `safeStorage` in Electron to encrypt and decrypt data. Provides methods for checking encryption availability and setting plain text encryption.	`src/platform/encryption/electron/mainEncryptionService.ts` `src/platform/encryption/common/encryptionService.ts`
Registers AI models and configures the application to use them.	Registers `AIModelRegistrant` in the main process. Adds `IAITextService` to the main and renderer instantiation services. Configures the application to use AI text models. Integrates AI-related configurations into the settings. Adds encryption support for status keys in the inspector. Adds AIModel registrant type.	`src/code/electron/app.ts` `src/code/browser/renderer.desktop.ts` `src/platform/registrant/common/registrant.ts` `src/platform/configuration/common/configurationRegistrant.ts` `src/workbench/services/workbench/configuration.register.ts` `src/code/browser/inspector/inspectorItemRenderer.ts` `src/code/browser/inspector/inspectorTree.ts` `src/code/browser/inspector/renderer.inspector.ts`
Standardizes error handling for LLM operations with the introduction of `AIError`.	Introduces the `AIError` class for encapsulating LLM-related errors. Provides detailed error information, including model name, category, HTTP status, and more. Improves error reporting and handling throughout the AI-related services.	`src/base/common/error.ts`
Improves type safety and code quality.	Adds `AsyncOnly` type to ensure all functions in an object return `Promise`. Updates `unwrapChannel` function to support `AsyncOnly` type.	`src/base/common/utilities/type.ts` `src/platform/ipc/common/proxy.ts`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @Bistard - I've reviewed your changes - here's some feedback:

Overall Comments:

The MainAITextService returns GPTModel for both TextModelType.GPT and TextModelType.DeepSeek. If DeepSeek should have different behavior, it needs its own model implementation.

Here's what I looked at during the review

🟡 General issues: 2 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

src/platform/ai/electron/mainAITextService.ts

src/base/common/json.ts

src/workbench/services/workbench/configuration.register.ts

Bistard · 2025-02-03T22:29:32Z

@sourcery-ai review

sourcery-ai

Hey @Bistard - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider standardizing error handling approach across the codebase - currently mixing Result types and direct throws/panics. Pick one consistent pattern for better reliability.

Here's what I looked at during the review

🟢 General issues: all looks good
🟡 Security: 1 issue found
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

src/platform/encryption/electron/mainEncryptionService.ts

src/platform/ai/electron/openAIModel.ts

…r` for improved error handling

Bistard · 2025-02-04T05:22:07Z

Sample usage for sending text:

…ase class

Bistard · 2025-02-04T20:06:51Z

@sourcery-ai guide

Bistard added 10 commits January 28, 2025 17:10

[Env] update openai to 4.80.1

832d183

[Feat] new configuration: application.ai.textModel

871a21d

Merge branch 'dev-hoverbox' into dev-ai

81b2255

[Fix] circular dependency on EditorPaneDescriptor

411d242

[Refactor] revist old AI-related files and renew them

2d35148

[Chore] rename GPTModel to TextGPTModel

0fd1201

[Chore]

f7864ef

[Chore]

8512f71

[Chore]

e1be271

[Refactor] introduce base class TextSharedOpenAIModel and introduce…

2949dd1

… `TextDeepSeekModel`

Bistard added core refactor main process renderer process AI labels Feb 1, 2025

Bistard requested a review from duckSoup0203 February 1, 2025 18:54

Bistard self-assigned this Feb 1, 2025

sourcery-ai bot reviewed Feb 1, 2025

View reviewed changes

src/platform/ai/electron/mainAITextService.ts Outdated Show resolved Hide resolved

src/base/common/json.ts Show resolved Hide resolved

src/workbench/services/workbench/configuration.register.ts Show resolved Hide resolved

Bistard added 11 commits February 1, 2025 16:57

[Chore] rename

35d5b04

[Feat] introduce IEncryptionService and registered into IPC

c65e9f6

[Fix] typo

806167d

[Feat] new api: isEncryptionAvailable()

3e7668b

[Doc]

f2ca0c0

[Fix] invalid configuration register

1ee2f13

[Fix] correctly set status and configuration in inspector window

c0ec640

[Fix] inspector encrypt data

633917b

[Feat] integrate API key handling (encrypt/decrypt)

9f1b917

[Feat] add AsyncOnly type utility to enforce ProxyChannel namespace

4a3f2da

[Refactor] avoid using AsyncResult in AI-related codes

4b734cf

Bistard added 7 commits February 2, 2025 22:49

[Chore]

67b026e

[Feat] new api: updateAPIKey

b3cacc9

[Chore] rename

76ffb76

[Feat] implement IPC channel for communication with AI text service

9f80d82

[Feat] implement streaming request handling in AI text channels

16cff02

[Fix] potential memory leak

2d74688

[Chore] rename

681d9aa

sourcery-ai bot reviewed Feb 3, 2025

View reviewed changes

src/platform/encryption/electron/mainEncryptionService.ts Show resolved Hide resolved

src/platform/ai/electron/openAIModel.ts Outdated Show resolved Hide resolved

Bistard added 5 commits February 3, 2025 21:49

[Typo]

f3fb513

[Chore]

11aa82c

[Fix] typo

803e53a

[Feat] new AIError class for standardized LLM error handling

e9d46ca

[Refactor] AITextService methods returns AsyncResult with `AIErro…

580d392

…r` for improved error handling

Bistard and others added 7 commits February 4, 2025 00:26

[Chore]

f65c600

[Chore]

147faa1

Merge branch 'dev-ai' of https://github.com/Bistard/nota into dev-ai

5558073

[Chore] fix

d478ea2

[Feat] new: AI.Modality

7d82296

[Feat] AI model registration and management system

b156a71

[Refactor] Rename model type to model name and introduce LLMModel b…

463aefc

…ase class

Bistard changed the title ~~Dev ai~~ dev-ai Feb 4, 2025

duckSoup0203 approved these changes Feb 6, 2025

View reviewed changes

Bistard merged commit 65526e2 into dev Feb 6, 2025
10 checks passed

Bistard deleted the dev-ai branch February 7, 2025 02:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dev-ai #264

dev-ai #264

Bistard commented Feb 1, 2025 •

edited

Loading

sourcery-ai bot commented Feb 1, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Bistard commented Feb 3, 2025

sourcery-ai bot left a comment

Bistard commented Feb 4, 2025

Bistard commented Feb 4, 2025

dev-ai #264

dev-ai #264

Conversation

Bistard commented Feb 1, 2025 • edited Loading

Summary by Sourcery

sourcery-ai bot commented Feb 1, 2025 • edited Loading

Reviewer's Guide by Sourcery

Sequence diagram for AI text request flow

Class diagram for AI text service and models

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Bistard commented Feb 3, 2025

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Bistard commented Feb 4, 2025

Bistard commented Feb 4, 2025

Bistard commented Feb 1, 2025 •

edited

Loading

sourcery-ai bot commented Feb 1, 2025 •

edited

Loading